feat: 1-click unsubscribe docs #800
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
connorlindsey
force-pushed
the
connor-kno-7966-docs-1-click-unsubscribe-link-docs
branch
from
73a2ae5 to
7b77a5d
Compare
|
|
||
| ### Using footer links | ||
|
|
||
| When configuring an email layout using the visual editor, you can toggle the "Include commercial unsubscribe link" input to include the unsubscribe link. |
There was a problem hiding this comment.
Might be helpful to include a screenshot here?
Co-authored-by: Rachael Thomas <[email protected]>
| @@ -15,6 +15,8 @@ When Knock runs a workflow for a user, we evaluate their `PreferenceSet`. A mess | |||
|
|
|||
| A preference set is built using three keys: `categories`, `channel_types`, `workflows`. These keys resolve to boolean values to determine if a user has opted out of receiving a notification. | |||
|
|
|||
| The default preference set also has the `commercial_unsubscribe` which determines if the recipient should receive notifications sent by commercial workflows or broadcasts. | |||
There was a problem hiding this comment.
| The default preference set also has the `commercial_unsubscribe` which determines if the recipient should receive notifications sent by commercial workflows or broadcasts. | |
| The `default` preference set also has a `commercial_unsubscribe` key which determines if the recipient should receive notifications sent by commercial workflows or broadcasts. |
There was a problem hiding this comment.
I wonder if we should include an example below? Also I think there are a few things we could disambiguate here:
- The term "default", since there's the environment-level "default preference set" in addition to a recipient's
defaultpreferences. - Whether we add this key in automatically (i.e.
"commercial_unsubscribe": true) to eachPreferenceSetthat is set in Knock, regardless of whether it is provided by the customer's application? - Does
true= send andfalse= don't send as usual? I think we should probably say this explicitly, because to me a setting of"commercial_unsubscribe": truereads like "it is true that I have unsubscribed, therefore I will not receive a message" but I think it's actually the opposite based on how our preferences model works.
There was a problem hiding this comment.
I see we include some of this on the other page under "Preference evaluation rules". I think it doesn't hurt to include at least some of the info in both places, in case someone reads the preferences overview page without looking further into commercial unsub. Perhaps linking from here to /preferences/commercial-unsubscribe#preference-evaluation-rules is enough
|
|
||
| 1. Adds required unsubscribe headers to all emails sent through that workflow or broadcast. | ||
| 1. Provides an unsubscribe URL variable that can be included in your email templates. | ||
| 1. Manages recipient opt-outs during preference set evaluation. |
There was a problem hiding this comment.
| 1. Manages recipient opt-outs during preference set evaluation. | |
| 1. Manages recipient opt-outs during [preference set evaluation](/preferences/overview#preference-evaluation-rules). |
Maybe a backlink to https://docs.knock.app/preferences/overview#preference-evaluation-rules here? And might be helpful to include some additional information about commercial unsubscribe in that section as well.
| 1. Navigate to the workflow or broadcast. | ||
| 1. For a workflow, click "Manage workflow." For a broadcast, click "Edit details." | ||
| 1. Toggle "Commercial." | ||
| 1. Save your changes. |
There was a problem hiding this comment.
Does this setting exist outside of commit model, or should we call that out too?
| ### Standard confirmation page | ||
|
|
||
| You can customize the title and body text that will appear on the Knock confirmation page. | ||
|
|
||
| ### Custom redirect URL | ||
|
|
||
| You can provide a URL that recipients should be redirected to after unsubscribing. |
There was a problem hiding this comment.
IMO, we could maybe cut these two subheaders completely and mention what is customizable under the "Configuring the confirmation page header" (i.e. without having separate sections), or we should include screenshots under these subheaders.
|
|
||
| ## Preference evaluation rules | ||
|
|
||
| When a recipient clicks the unsubscribe link, their default preference set will be updated, marking `commercial_unsubscribe` as true. They will be opted-out of commercial messages, and they will continue to receive transactional messages based on their other preferences. |
There was a problem hiding this comment.
| When a recipient clicks the unsubscribe link, their default preference set will be updated, marking `commercial_unsubscribe` as true. They will be opted-out of commercial messages, and they will continue to receive transactional messages based on their other preferences. | |
| When a recipient clicks the unsubscribe link, their `default` preference set will be updated, marking `commercial_unsubscribe` as `true`. They will be opted-out of commercial messages, and they will continue to receive transactional messages based on their other preferences. |
There was a problem hiding this comment.
Question: how do we handle this for tenant-specific preferences? What happens if a tenant is applied to a given workflow trigger (either when the email that has the unsub link in it is generated, or after they have clicked it on a different workflow run's email)?
Description
First pass at 1-click unsubscribe docs
Todos
Tasks
KNO-7966